Skip to content

DOC-13899 Product Change- PR #147439 - ui: surface SQL commenter query tags in insights #19897

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

florence-crl
Copy link
Contributor

@florence-crl florence-crl commented Jul 7, 2025

Fixes DOC-13899 DOC-13614

In include file insights.md, (1) added section for Query tags and (2) corrected SQL CPU Time column name.

Rendered preview

Copy link

github-actions bot commented Jul 7, 2025

Files changed:

Copy link

netlify bot commented Jul 7, 2025

Deploy Preview for cockroachdb-api-docs canceled.

Name Link
🔨 Latest commit 87949f1
🔍 Latest deploy log https://app.netlify.com/projects/cockroachdb-api-docs/deploys/687940b4baef13000816abd9

Copy link

netlify bot commented Jul 7, 2025

Deploy Preview for cockroachdb-interactivetutorials-docs canceled.

Name Link
🔨 Latest commit 87949f1
🔍 Latest deploy log https://app.netlify.com/projects/cockroachdb-interactivetutorials-docs/deploys/687940b47ece3600079263ff

Copy link

netlify bot commented Jul 7, 2025

Netlify Preview

Name Link
🔨 Latest commit 87949f1
🔍 Latest deploy log https://app.netlify.com/projects/cockroachdb-docs/deploys/687940b4ece3970008462378
😎 Deploy Preview https://deploy-preview-19897--cockroachdb-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@florence-crl florence-crl requested review from mikeCRL, angles-n-daemons, kyle-a-wong and kevin-v-ngo and removed request for mikeCRL July 7, 2025 19:51
Copy link

@angles-n-daemons angles-n-daemons left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, thanks for adding this!

@florence-crl florence-crl requested a review from mikeCRL July 10, 2025 17:21
Copy link

@kevin-v-ngo kevin-v-ngo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Small nits regarding how SQL comments (that following the SQLcommenter specification) is an opt-in experience that can be used for application correlation.

Copy link
Contributor

@mikeCRL mikeCRL left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left some suggestions.

Also want to be sure you're aware of the various capitalizations of SQLcommenter: Google's blog uses Sqlcommenter, the repo uses sqlcommenter, and their docs are mixed, often using SQL commenter with a space. Not an easy call which one to use, and I can even see an argument for leaving as SQLcommenter.

@florence-crl florence-crl requested a review from kevin-v-ngo July 17, 2025 18:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants